home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / network / tech3.zip / TECH.DOC < prev   
Text File  |  1990-06-13  |  49KB  |  1,541 lines
  1.  
  2.         LANtastic (tm) Network Operating System
  3.               Technical Reference Manual
  4.        =================================================
  5.  
  6. Introduction
  7. ************
  8.  
  9. This manual is intended for programer who wish to make use of the
  10. network services of the LANtastic Network Operating System (LANOS). 
  11. LANOS services described in this manual are for version 3.00 or above.
  12. LANOS services fall into two catagories: Standard MS-DOS compatible
  13. network functions and Extended network functions.  Since LANOS runs
  14. on any NETBIOS compatible LAN, NETBIOS functions are also available
  15. although they are intrisic to the underlying NETBIOS implementation. 
  16.  
  17. This manual assumes that the reader is familiar with 8088/8xx6
  18. assembly language and DOS system functions.  Since the standard
  19. MS-DOS compatible network functions are described in the DOS
  20. technical reference manual, we will not go into great detail in this
  21. manual. 
  22.  
  23. Throughout this manual references will be made to network paths. 
  24. LANOS network paths are fully compatibly with MS-DOS network paths. 
  25. Network paths are similar to file paths except that they reference
  26. files through the network.  The general syntax for network path is
  27.  
  28.     \\server-name\path-name
  29.  
  30. where
  31.     server-name    is 1 to 15 character name of a network file server
  32.     path-name    is a DOS path on the server
  33.  
  34. For example,
  35.  
  36.     \\MAIN-MACHINE\PROGS\DATA\FROG.TXT
  37.  
  38. refers to a file located on server MAIN-MACHINE.  The path required
  39. to access the file is PROGS\DATA\FROG.TXT.  The directory PROGS is a
  40. shared network directory and may not actually exist on the server. It
  41. may in fact be an entire disk.
  42.  
  43. MS-NET compatible networks (e.g. IBM-PC LAN) do not fully support
  44. full paths for all systems calls (in particular Find FIrst).  LANOS,
  45. however, supports full paths for all system calls that can take a
  46. path argument.  This means that many public domain directory
  47. utilities will operate with a network path.  Refer to the "Other
  48. useful system calls" section for example uses of find-first/next.
  49.  
  50.  
  51. Indirect Files
  52. **************
  53.  
  54. As of version 3.00 of LANOS, a new type of file has been created for
  55. use on the network.  This file type, know as an indirect file,
  56. resides on a server and is accessable to all users with the 'I' ACL
  57. privilege.  An indirect file contains server relative path
  58. information that is expanded in place of the file's name when a path
  59. is parsed by the server.  In other words, an indirect file points to
  60. another file or directory.  Whenever you refer to the indirect file,
  61. its name is replaced by the file or directry it refers to.
  62.  
  63. The folowing examples illustrate the operation of indirect files.
  64.  
  65. Given the following indirect files
  66.  
  67.     Indirect file            Contents
  68.     -------------------        ---------------------
  69.     \ROOT\A                \ROOT\AUTOEXEC.BAT
  70.     \MISC\C                \ROOT\CONFIG.SYS
  71.     \ROOT\SOURCES\WIN.H        ..\INCLUDE\WINDOW.H
  72.     \ROOT\DOC            \MISC\MANUALS\NEW\DOC
  73.  
  74. Some sample path expansions would be
  75.  
  76.     Path                Expansion
  77.     --------------------        --------------------------------
  78.     \ROOT\A                \ROOT\AUTOEXEC.BAT
  79.     \MISC\C                \ROOT\CONFIG.SYS
  80.     \ROOT\SOURCES\WIN.H        \ROOT\INCLUDE\WINDOW.H
  81.     \ROOT\DOC\INTRO            \MISC\MANUALS\NEW\DOC\INTRO
  82.     \ROOT\DOC\CHAPTERS\1        \MISC\MANUALS\NEW\DOC\CHAPTERS\1
  83.  
  84. As you can see from the above examples, indirect files can be used to
  85. point to other files or directories.  The advantage of indirect files
  86. is that the actual files or directories that they point to can reside
  87. on one area while multiple indirect file can reference them with a
  88. variety of names while residing in another directory.
  89.  
  90. Since the concept of indirect files does not exists under DOS. 
  91. Indirect files are not available directly from DOS.  To use indirect
  92. files you must reference them through the network.
  93.  
  94. System calls that are useful for the manipulation of indirect files
  95. are
  96.  
  97.     5FB3H    Translate path
  98.     5FB4H    Create indirect file
  99.     5FB5H    Get indirect file contents
  100.  
  101.  
  102.  
  103. Error Codes
  104. ***********
  105.  
  106. All MS-DOS compatible system calls and all LANOS specific system calls
  107. return error codes.  The error code number is always returned in AX. 
  108. When an error occurs the carry flag (CY) is set.  LANOS provides a
  109. mechanism for expanding the error code number into a text string.  The
  110. following is a list of error codes which may be returned by LANOS:
  111.  
  112. Error
  113. Number    Meaning
  114. ------    -------
  115. 01H    Invalid function number
  116. 02H    File not found
  117. 03H    Path not found
  118. 04H    File open limit has been exceeded or no handles left
  119. 05H    Access denied
  120. 06H    Invalid handle
  121. 07H    Memory control blocks destroyed
  122. 08H    The memory limit has been exceeded
  123. 09H    Invalid memory block address
  124. 0AH    Invalid environment
  125. 0BH    Invalid format
  126. 0CH    Invalid access code
  127. 0DH    Invalid data
  128. 0EH    RESERVED
  129. 0FH    Invalid drive was specified
  130. 10H    Attempt to remove current directory
  131. 11H    Not same device
  132. 12H    No more files
  133. 13H    Attempt to write on write protected disk
  134. 14H    Unknown unit
  135. 15H    Drive not ready
  136. 16H    Unknown command
  137. 17H    Data CRC error
  138. 18H    Bad req stuc length
  139. 19H    Seek error
  140. 1AH    Unknown media
  141. 1BH    Sector not found
  142. 1CH    No paper
  143. 1DH    Write fault
  144. 1EH    Read fault
  145. 1FH    General failure
  146. 20H    Sharing violation
  147. 21H    Lock violation
  148. 22H    Invalid disk change
  149. 23H    FCB unavailable
  150. 24H    Sharing buffer overflow
  151. 25H    RESERVED
  152. 26H    Cannot complete file operation
  153. 27H-31H    RESERVED
  154. 32H    Network request not supported
  155. 33H    Network node ??????????????? is not listening
  156. 34H    The name already exists on the network
  157. 35H    Cannot locate network name
  158. 36H    The network is busy
  159. 37H    Server connection to network node ??????????????? broken
  160. 38H    The NETBIOS command limit has been exceeded
  161. 39H    The network adapter has malfunctioned
  162. 3AH    Incorrect response received from network node ???????????????
  163. 3BH    Unexpected network error from network node ???????????????
  164. 3CH    Incompatible network node ???????????????
  165. 3DH    Print queue full on network node ???????????????
  166. 3EH    No room for print file on network node ???????????????
  167. 3FH    The print file has been deleted on network node ???????????????
  168. 40H    The network name has been deleted
  169. 41H    You have been denied access on network node ???????????????
  170. 42H    Invalid network device
  171. 43H    The network name was not found
  172. 44H    The network name limit has been exceeded
  173. 45H    The session limit has been exceeded
  174. 46H    Network node ? has been temporarily paused
  175. 47H    The network request to network node ? was denied
  176. 48H    Print or disk redirection is paused on network node ???????????????
  177. 49H    Invalid network version
  178. 4AH    Account has expired
  179. 4BH    Password has expired
  180. 4CH    Login attempt invalid at this time
  181. 4DH    Disk limit has been exceeded on network node ???????????????
  182. 4EH    Not logged in to network node ???????????????
  183. 4FH    RESERVED
  184. 50H    The file already exists
  185. 51H    RESERVED
  186. 52H    Cannot make directory entry
  187. 53H    Failure on critical error
  188. 54H    Too many redirections or logins to network node ???????????????
  189. 55H    Duplicate redirection or login to network node ???????????????
  190. 56H    Invalid username or password
  191. 57H    Invalid parameter
  192. 58H    Network data fault
  193. 59H    Function not supported on network
  194. 5AH    Required system component not installed
  195.  
  196. When you expand the error code into a text string the above question
  197. marks are expanded to the name of the node you were refering to.  To
  198. expand an error code into a text string you will need to issue a
  199. multiplex interrupt (2FH).  The calling sequence is
  200.  
  201. INPUT    AH    5
  202.     AL    0    For installation check
  203.         #    for error code (in pre DOS 4.00)
  204.         1 or 2    for error code in DOS 4.00
  205.     BX    in    Error code
  206. OUTPUT    FLAGS    NC if error code converted to text
  207.         CY is error code can't be converted
  208.     ES:DI    Pointer to ASCIZ text buffer containing error text. 
  209.         This is a read only text buffer and you    must not alter
  210.         the text in this buffer.
  211.  
  212. If the error code is RESERVED it is expanded to "General failure".  The
  213. maximum width for the question mark fields is 15 characters.  The error
  214. text is automatically adjusted so that extra spaces are not in the text
  215. buffer.  For example the error text
  216.  
  217.     Network node ??????????????? is not listening
  218.  
  219. would be 
  220.  
  221.     Network node HOST is not listening
  222.  
  223. for node HOST.
  224.  
  225. When coding for LANOS the following code se